NickAkhmetov/CAT-751 Prevent full-page errors from malformed provenance data #3560
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
john-conroy
previously approved these changes
Oct 7, 2024
| <Stack p={4}> | ||
| <Typography variant="subtitle1">An error occurred while attempting to display the provenance graph.</Typography> | ||
| <DetailsAccordion summary="Click to expand error details"> | ||
| <div>{error?.message}</div> |
There was a problem hiding this comment.
Should this div be a Typography instead?
There was a problem hiding this comment.
I'll swap it in and use body2 👍🏻
john-conroy
approved these changes
Oct 7, 2024
NickAkhmetov
deleted the
nickakhmetov/cat-751-provenance-graph-error-boundary
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This donor's provenance data is incomplete (it is missing the edges that connect activities to their parent entities): https://portal.hubmapconsortium.org/browse/donor/a0bdb4249eb3a6bd1865f948875c2f96
Removing the
requiredstatus from that key does not resolve the issue, since these edges are mandatory to be able to draw the graph.I have escalated the underlying data issue to Zhou in a private message; in the meantime, we can improve the way this error is handled on the front-end by preventing the triggering of the full-page error boundary and interrupting the user's browsing session.
I used the same
DetailsAccordioncomponent we use to report Vitessce visualization errors to be consistent.Design Documentation/Original Tickets
https://hms-dbmi.atlassian.net/browse/CAT-751
Testing
The problematic donor page has been visited with the dev server configured to suppress exception overlays to confirm that only the appropriate error handling is included.
Screenshots/Video
Checklist
CHANGELOG-your-feature-name-here.mdis present in the root directory, describing the change(s) in full sentences.Additional Notes
Should we consider removing the webpack dev server error overlay in general? It seems counterproductive since it takes up the full page, which errors not caught by a lower-level error boundary do as well; not having this overlay might encourage us to add targeted boundaries such as this.